Payment Initiation APIs 4.0
Important Information & Bank of Ireland’s API Implementation
This page is a reflection of Bank of Ireland’s implementation of the Open Banking Payment Initiation Service APIs.
Common across both ROI & NIGB Domestic Payments (Including SEPA and SEPA Instant)
Known Issues
BOI are aware of an issue which is preventing payments being initiated to accounts with account number ‘00000000’. Please use a different account number when testing. TPPs impacted by this limitation are encouraged to contact the bank.
| Channel | Behavior |
| Banking 365 Online (B365) | Payments received after the cut-off time are accepted and processed on the next working day. |
| Business On Line (BOL) | Payments are accepted up to the cut-off time. Payments submitted after the cut-off time are rejected. |
| SEPA Instant (EUR) for B365 and BOL | Available 24x7 with no cut-off times. Payments are processed instantly. |
Note: Refer to the published BOI cut-off time schedules applicable to your jurisdiction and channel.
• UK - BOL
• UK - 365
Payee Name Length
| Channel | Jurisdiction | Maximum Length | Notes |
| BOL | UK & ROI | 50 characters | Requests exceeding 50 characters will be rejected. |
| B365 | UK | 350 characters | Only the first 70 characters are logged; the remaining 280 characters are staged and not used for payment processing. |
| B365 | ROI | 70 characters | Requests exceeding 70 characters will be rejected. |
Supported Fields
Bank of Ireland does not support the below fields & Blocks in response messages:
• CutOffDateTime
• ExpectedExecutionDateTime
• ExpectedSettlementDateTime
• SCASupportData Block
• SupplementaryData Block
• Debtor Block
• Status Reason Block
Bank of Ireland will only support one occurrence for the below mentioned blocks: -
• Regulatory Reporting
• Regulatory Reporting /Details
• RemittanceInformation/Structured
• RemittanceInformation/Structured/Referred Document Information
Bank of Ireland will only support one line for the below mentioned fields: -
| Field | Maximum Length |
| Regulatory Reporting / Details / Information | 35 Characters |
| RemittanceInformation / Unstructured | 140 Characters |
| RemittanceInformation / Structured / Additional Remittance Information | 140 Characters |
| RemittanceInformation / Structured / Referred Document Information / Line Details | Single Line Only |
If the TPP includes above mentioned blocks and fields more than once in the request payload, the payment request will be rejected.
Supported Characters
Bank of Ireland supports only the special characters listed below. Requests containing any other special characters will be rejected.
| Field(s) | Supported Special Characters |
| Payer Name, Payee Name, EndToEndIdentification | / - : ' + Space |
| All Other Fields | / - ? : ( ) . , ' + Space |
Note: Requests containing unsupported special characters will be rejected.
Supplementary information
All APIs will only return one error message in the response in case of an error scenario. Please make sure that you have provided all information that is required for a successful API call.
Scheme Name Validation
• The UK.OBIE prefix is mandatory for both Payer and Payee Scheme Names.
• Requests with any other Scheme Name will be rejected.
| Jurisdiction | Supported Scheme Name |
| ROI | UK.OBIE.IBAN |
| UK | UK.OBIE.SortCodeAccountNumber |
Payment Status
ROI SEPA Classic:
For SEPA Classic, for B365 and Business On Line Channel, the final status supported by Bank of Ireland is “ACSP”. BOI is unable to provide the “ACSC” status as this is not supported in the bank’s existing online payments channels. We are aware that this may cause challenges with Open Banking / API payments and would invite TPPs to contact us if this limitation impacts them.
UK Domestic Payments:
On B365 and BOL Channel the final status supported by Bank of Ireland is “ACSP”. BOI is unable to provide the “ACSC” status as this is not supported in the bank’s existing online payments channels. We are aware that this may cause challenges with Open Banking / API payments and would invite TPPs to contact us if this limitation impacts them.
SEPA Instant Payments:
For SEPA Instant Single Shot Domestic Payments for ROI, for B365 (Non BOI payees) and BOL (BOI and non BOI payees) channel, the final status supported is “ACSC”. For B365 (BOI Payees) the final status supported is “ACSP”. (Refer to Event Notification Important Information for more details).
For ROI & UK Standing Order/Scheduled Payments only:
Final Status supported are as follows:
| Payment Type | B365 | BOL |
| Domestic Standing Order | INCO | N/A |
| Domestic Scheduled Payment | ACSP | ACSP, RJCT |
Additional Notes:
• RJCT is not supported for B365 Standing Orders and Scheduled Payments.
If a payment or standing order is rejected downstream or by the beneficiary bank, the status will not be updated.
• RJCT is supported for Domestic Scheduled Payments on the BOL channel only.
Domestic Payment API: Local Instrument
Local Instrument field on the Domestic API will be used to indicate how the payment should be processed.
Note: ROI BOI-to-BOI payments should be submitted as SEPA Classic, as they are settled immediately through BOI's internal bookkeeping system.
| Local Instrument | Jurisdiction | Processing |
| Blank or UK.OBIE.SEPACreditTransfer | ROI | SEPA Classic |
| UK.OBIE.SEPAInstantCreditTransfer | ROI | SEPA Instant |
| Not specified (UK) | UK | Domestic Payment (Next Day) |
| UK.OBIE.CHAPS | UK | BOL CHAPS Payment |
| UK.OBIE.Target2 | ROI |
BOL SDMT (Same Day Money Transfer) Domestic Scheduled Payment |
Confirmation of Funds for PIS (Domestic Payment)
Availability
| Applicable To | Details |
| Jurisdictions | Bank of Ireland UK PLC and Bank of Ireland (ROI) |
| Channels | Banking 365 Online (B365) and Business On Line (BOL) |
Key Features
• Funds Check is supported for Domestic Payments once the payment-order-consent status is AUTH.
• To access the Confirm Funds GET API, the PISP must obtain an Access Token using the Authorisation Code Grant in a secure server-side context between the PISP and ASPSP.
• At payment submission, BOI performs a funds check again and immediately debits the customer's account.
• A negative response is returned where sufficient funds are not available.
Rejection Scenarios
Confirmation of Funds requests will be rejected if:
• The account has been closed.
• Joint account access has been revoked.
• The account has been downgraded due to credit status.
• The requested currency differs from the account currency.
Unsupported Payment Types
| Payment Type | Funds Check Timing |
| Domestic Scheduled Payments | On processing date only |
| Domestic Standing Orders | On processing date only |
Note: For Domestic Scheduled Payments and Domestic Standing Orders, funds checks are not performed during authorisation or submission and are instead carried out on the day of processing.
Reverse Payments
• In the Refund block the Secondary Identification field will be populated if the account is pre-selected and secondary identification information is passed by TPPs.
• Bank of Ireland will return null for the secondary identification field in the Refund block if the account is selected at Bank’s end
Multi-Auth for BOL Channel
Bank of Ireland supports Multi-authorisation for the following payment types for Business On Line channel:
• SEPA Classic Payment
• ROI SEPA Instant Payment
• Domestic Payment BACS (UK)
• Domestic Scheduled Payment BACS (UK)
• CHAPS Domestic Payments (UK)
• CHAPS Domestic Scheduled Payment (UK)
• Same Day Money Transfer Domestic Payment (ROI)
• Same Day Money Transfer Domestic Scheduled Payment (ROI)
If a payment requires 2nd level (dual) authorisation, BOI returns the MultiAuthorisation block including the status of the payment in the payment submission response.
A multi-auth payment can have one of the 3 valid statuses:
• AWAF
• AUTH
• RJCT
The 2nd level authoriser can Authorise or Reject a payment. The payment details cannot be amended once it has been submitted.
The following optional field(s) is/are not populated by BOI for this API:
• MultiAuthorisation.NumberRequired
• MultiAuthorisation.NumberReceived
• MultiAuthorisation.LastUpdateDateTime
• MultiAuthorisation.ExpirationDateTime
Domestic Payments
Currencies
• Bank of Ireland only supports GBP (UK)
• Bank of Ireland only supports EUR (ROI)
Address Requirements
| Payment Type | Jurisdiction | Channel | Creditor Postal Address | Creditor Agent Postal Address |
| Domestic Payments (CHAPS) | UK | BOL | Mandatory, Country & Town Name (from 14-Nov-26) must be provided in the payload. | Optional, if provided, Country & Town Name (from 14-Nov-26) must be provided in the payload. |
| Domestic Payments (BACS) | UK | B365, BOL | Optional, if provided not considered for posting the transaction. | Optional, if provided, will be supported for staging. |
| Domestic Payments | ROI | B365 | Not required, if provided, error on UI is expected. If provided, Country & Town Name must be provided in the payload. | Optional, if provided, Country & Town Name (from 14-Nov-26) must be provided in the payload. |
| Domestic Payments | ROI | BOL | Mandatory, Country, AddressLine1 & Town Name (from 14-Nov-26) must be provided in the payload. | Optional, if provided, Country & Town Name (from 14-Nov-26) must be provided in the payload. |
| Domestic Scheduled Payments | ROI | B365 | Not required, if provided, error on UI is expected. If provided, Country & Town Name must be provided in the payload. | Optional, if provided, Country & Town Name (from 14-Nov-26) must be provided in the payload. |
| Domestic Scheduled Payments | ROI | BOL | Mandatory, Country, AddressLine1 & Town Name (from 14-Nov-26) must be provided in the payload. | Optional, if provided, Country & Town Name (from 14-Nov-26) must be provided in the payload. |
| Domestic Scheduled Payments (CHAPS) | UK | BOL | Mandatory, Country & Town Name (from 14-Nov-26) must be provided in the payload. | Optional, if provided, Country & Town Name (from 14-Nov-26) must be provided in the payload. |
| Domestic Scheduled Payments (BACS) | UK | B365, BOL | Optional, if provided not considered for posting the transaction. | Optional, if provided, will be supported for staging. |
| Domestic Standing Order | UK, ROI | B365 | N/A | N/A |
Note: For Domestic payments, where CreditorPostalAddress block and CreditorAgentPostalAddress block are mandatory or not required, no validation error will be displayed during the POST Consent (payment setup) request if these blocks are missing from the payload (if these are blocks are mandatory) or incorrectly included (when they are not required).
Instead, the request will fail later in the Consent Journey, before reaching the authentication URL, due to the unavailability of the required channel for failure identification.
| Field | Requirement |
| Maximum Length per Address Line | 35 characters |
Note: Country & Town Name (from 14-Nov-26) is mandatory in case CreditorPostalAddress is passed.
SEPA Reachability
All SEPA countries are reachable via the Bank of Ireland (ROI) Domestic Payments API.
SEPA Instant Payments - Single Shot Credit Transfer
| Attribute | Details |
| Applicable Channels | B365 and BOL (ROI) |
| Currency | EUR |
| Local Instrument | UK.OBIE.SEPAInstantCreditTransfer |
| Valid Scheme Name | UK.OBIE.IBAN |
| Payment Identification | Payment type "Instant" is displayed on the Consent Authorisation screen |
ROI On-Us Payments (BOI to BOI):
• Payments to a valid BOI account are credited immediately.
• These payments are not processed through the SEPA Instant scheme.
• Real-time event notifications do not apply to ROI B365 On-Us payments.
Third-Party Payments (BOI to Other Banks):
• TPPs are notified of the final payment status using real-time event notifications.
• For both B365 and BOL, if a SEPA Instant Single Shot payment remains in ACSP status for more than 10 minutes after initiation, the TPP or customer should contact the bank to determine the reason for the payment failure.
CHAPS Payments
CHAPS Domestic Payments and CHAPS Domestic Scheduled Payments are available for the Business On Line (BOL) channel.
| Feature | Details |
| Payment Types | Same-day CHAPS and Future-Dated CHAPS Payments |
| Future-Dated Limit | Up to 30 working days |
| Currency | GBP to GBP only |
| Local Instrument | UK.OBIE.CHAPS |
| Creditor Postal Address | Mandatory for all CHAPS payments initiated by BOL customers |
| Cut-off Time | Single-shot CHAPS payments submitted after the cut-off time will be rejected |
| Weekend/Bank Holiday Processing | Future-dated CHAPS payments scheduled for a Saturday, Sunday, or Bank Holiday will be rejected |
| Charges | CHAPS payments are charged as per the agreed rates with the bank |
Additional Information
• TPPs must include LocalInstrument = UK.OBIE.CHAPS in the payment initiation request to identify a CHAPS payment.
• Refer to the published BOI cut-off time and fee schedules for further details.
Same Day Money Transfer (SDMT) Payments
SDMT Domestic Payments and SDMT Domestic Scheduled Payments are available for the Business On Line (BOL) channel.
| Feature | Details |
| Payment Types | Same-day SDMT and Future-Dated SDMT Payments |
| Future-Dated Limit | Up to 30 working days (Not-On-Us) and 45 working days (On-Us) |
| Currency | EUR to EUR only |
| Local Instrument | UK.OBIE.Target2 |
| Cut-off Time | Single-shot SDMT payments submitted after the cut-off time will be rejected |
| Weekend/Bank Holiday Processing | Future-dated SDMT payments scheduled for a Saturday, Sunday, or Bank Holiday will be rejected |
| Charges | SDMT payments are charged as per the agreed rates with the bank |
Note: TPPs must include LocalInstrument = UK.OBIE.Target2 in the payment initiation request to identify an SDMT payment.
Domestic Scheduled Payment
| Feature | B365 | BOL |
| Future-Dated Limit | Up to 60 calendar days | Up to 45 working days |
| Weekend / Bank Holiday Payment | Processed on the next working day | Rejected |
| Customer Cancellation | Supported before execution; TPP is not notified | Supported before execution; TPP is not notified |
Additional Notes
• Scheduled payments can be cancelled by the customer before execution.
• The TPP will not be notified of customer-initiated cancellations.
• SEPA Instant Payments do not support scheduled payments.
Standing Orders
Validation Rules
• Only open-ended standing orders are supported. Requests containing an end date will be rejected.
• The first, recurring, and last payment amount must be the same. Requests with different amounts will be rejected.
• Only Start Date and Frequency are supported. Any recurring date provided will be ignored and recalculated based on the Start Date and Frequency.
• Supported frequencies are:
oWEEK
oFRTN
oMNTH
oYEAR
Frequency Validation
| Frequency Submitted | BOI Processing |
| ADHO | Reject (400 Bad Request) |
| DAIL | Accept |
| YEAR | Accept |
| FRTN | Accept |
| INDA | Reject (400 Bad Request) |
| QURT | Reject (400 Bad Request) |
| MIAN | Reject (400 Bad Request) |
| WEEK | Accept |
Additional Validations
Standing Orders must have a minimum value of £1.00. Requests below this value will return an error.
Standing Order Payment Limits
| Product | Limit |
| Bank of Ireland (ROI) DSO | Up to €5,000 |
| Bank of Ireland (ROI) NDSO | Up to €3,000 |
| Bank of Ireland (UK) DSO | Up to £5,000 |